-
Notifications
You must be signed in to change notification settings - Fork 34
DOCSP-47058: Shift TOC #251
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
✅ Deploy Preview for docs-php-library ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
looks super clean but requesting changes just to be able to have another look before you merge!
config/redirects
Outdated
|
||
# comprehensive coverage redirects | ||
[v2.x-*]: ${prefix}/${version}/aggregation/atlas-search/ -> ${base}/${version}/atlas-search/ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Q: are we going to backport the TOC changes as we've done with the other languages? in that case, should you redirect all versions?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If that's what we've done for the others then yes I'll backport to all for PHP too, fixed!
config/redirects
Outdated
[v2.x-*]: ${prefix}/${version}/write/ -> ${base}/${version}/ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
S: consider redirecting these to the CRUD landing page instead
config/redirects
Outdated
[v2.x-*]: ${prefix}/${version}/connect/tls/ -> ${base}/${version}/security/tls/ | ||
[v2.x-*]: ${prefix}/${version}/aggregation/vector-search/ -> ${base}/${version}/vector-search/ | ||
[v2.x-*]: ${prefix}/${version}/monitoring/ -> ${base}/${version}/ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
S: consider redirecting to the monitoring-logging.txt landing page
source/crud.txt
Outdated
Operations with Builders </crud/builders> | ||
|
||
CRUD (Create, Read, Update, Delete) operations enable you to work with | ||
data stored in MongoDB. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
S: add a sentence introducing the list
- "Visit the following guides to learn more about performing CRUD operations on the data in your MongoDB collections... etc"
source/crud/bulk-write.txt
Outdated
@@ -68,7 +68,7 @@ specify the write operations: | |||
.. tip:: | |||
|
|||
For more information about delete, insert, replace, and update | |||
operations, see the :ref:`Write operation guides <php-write>`. | |||
operations, see the :ref:`CRUD <php-crud-operations>` section. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
operations, see the :ref:`CRUD <php-crud-operations>` section. | |
operations, see the :ref:`php-crud-operations` guides. |
source/get-started.txt
Outdated
- Learn how to perform read and write operations in the :ref:`<php-crud-operations>` section. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
S: nit - dont need <> brackets when importing the ref title directly
- Learn how to configure your MongoDB connection in the :ref:`<php-connect>` section. | |
- Learn how to perform read and write operations in the :ref:`<php-crud-operations>` section. | |
- Learn how to configure your MongoDB connection in the :ref:`php-connect` section. | |
- Learn how to perform read and write operations in the :ref:`php-crud-operations` section. |
source/issues-and-help.txt
Outdated
|
||
.. meta:: | ||
:keywords: php, troubleshooting, feedback | ||
:description: Find support for the {+library-short+, report bugs or feature requests, and learn how to contribute. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
:description: Find support for the {+library-short+, report bugs or feature requests, and learn how to contribute. | |
:description: Find support for the PHP library, report bugs or feature requests, and learn how to contribute. |
source/issues-and-help.txt
Outdated
|
||
.. note:: | ||
|
||
Bug reports in the PHP Jira project are publicly viewable. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Bug reports in the PHP Jira project are publicly viewable. | |
Bug reports in the PHPLIB Jira project are publicly viewable. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
lgtm!
@@ -21,14 +21,12 @@ toc_landing_pages = [ | |||
"/reference/class/MongoDBModelDatabaseInfo", | |||
"/reference/class/MongoDBModelIndexInfo", | |||
"/connect", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
S: add /connect/connection-options/
source/index.txt
Outdated
Atlas Vector Search | ||
------------------- | ||
|
||
Learn how to run Atlas Vector Search queries in the :ref:`<php-vector-search>` section. | ||
|
||
Optimize Queries with Indexes |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
S: this item is out of order
Release Notes </references/release-notes> | ||
Compatibility </references/compatibility> | ||
Upgrade Guides </references/upgrade> | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
S: add short sentence introducing sub pages
* Add redirects workflow * DOCSP-47058: Shift TOC (#251) * DOCSP-47058: Shift TOC * edits * issues and help, edits * fix errors * redirects * landing * RR feedback * RR feedback 2 * fix gh action * DOCSP-47057: Network compression (#254) * DOCSP-47057: Network compression * delete * edits * MM feedback * DOCSP-47055: Collation (#258) * DOCSP-47055: Collation * add to each page * edit * edits * list format * SA feedback * DOCSP-47060: Causal consistency (#261) * DOCSP-47060: Causal consistency * edits * Fix phpcs workflow * First fixes * Fix trailing commas * Fix string quoting * Fix whitespace errors * Fix use statements * Exclude sniff that would break comments * Fix multiline function declarations * Fix wrong array indentation * Fix snake_case variable names * Remove more false-positive errors * Fix control structure spacing * Fix arrays * Use property promotion * Simplify multiline array rules * Check code formatting (#265) * Check code formatting * fix highlighting * DOCSP-47059: Work with BSON (#263) * DOCSP-47059: Work with BSON * edits * RR feedback * enum ex * feedback * DOCSP-50222: Reorganize auth pages (#266) * DOCSP-50222: Reorganize auth pages * edits * fix * snooty * DOCSP-47065: Load balancing (#257) * DOCSP-47065: Load balancing * edit * word * RR feedback * DOCSP-47056: Monitoring (#260) * DOCSP-47056: Monitoring * fixes * fix * wording * table * widths * SA feedback * PV feedback * DOCSP-47071: Extended JSON (#268) * DOCSP-47071: Extended JSON * edits * vale * feedback * DOCSP-47072: Client parameters (#273) * DOCSP-47072: Client parameters * edits * fix * DOCSP-47069: Polling SRV records (#274) * DOCSP-50753: agg tutorial link (#275) * DOCSP-47063: Logging (#267) * DOCSP-47063: Logging * edits * word * feedback * code edit * fix * JT feedback * edit * spacing * gh link * JT feedback 2 * RR feedback * DOCSP-50185: Connection troubleshooting (#272) * DOCSP-50185: Connection troubleshooting * edits * remove sharedinclude * fix * wording * fix * MM feedback * DOCSP-50220: Break up FAQ (#276) * DOCSP-50220: Break up FAQ * edits * RM feedback * AB feedback * fix highlight * DOCSP-50960: Install with pie (#278) * DOCSP-50960: Install with pie * edits * RR feedback * JT feedback * DOCSP-51123: CC edits and cleanup (#279) * DOCSP-51123: CC edits and cleanup * build * composer * code errors * commas * more phpcs errors * edits * phpcs * code fixes * more phpcs * fix * RR feedback * DOCSP-50772: isView() (#281) * DOCSP-50772: isView() * fix manual link Co-authored-by: Nora Reidy <[email protected]> --------- Co-authored-by: Nora Reidy <[email protected]> * phpcs * vale * use toc labels/titles * more titles * label * Drop psalm analysis for doc examples * AB feedback * filter * title changes * build errors --------- Co-authored-by: Andreas Braun <[email protected]> Co-authored-by: Rea Rustagi <[email protected]>
* Add redirects workflow * DOCSP-47058: Shift TOC (#251) * DOCSP-47058: Shift TOC * edits * issues and help, edits * fix errors * redirects * landing * RR feedback * RR feedback 2 * fix gh action * DOCSP-47057: Network compression (#254) * DOCSP-47057: Network compression * delete * edits * MM feedback * DOCSP-47055: Collation (#258) * DOCSP-47055: Collation * add to each page * edit * edits * list format * SA feedback * DOCSP-47060: Causal consistency (#261) * DOCSP-47060: Causal consistency * edits * Fix phpcs workflow * First fixes * Fix trailing commas * Fix string quoting * Fix whitespace errors * Fix use statements * Exclude sniff that would break comments * Fix multiline function declarations * Fix wrong array indentation * Fix snake_case variable names * Remove more false-positive errors * Fix control structure spacing * Fix arrays * Use property promotion * Simplify multiline array rules * Check code formatting (#265) * Check code formatting * fix highlighting * DOCSP-47059: Work with BSON (#263) * DOCSP-47059: Work with BSON * edits * RR feedback * enum ex * feedback * DOCSP-50222: Reorganize auth pages (#266) * DOCSP-50222: Reorganize auth pages * edits * fix * snooty * DOCSP-47065: Load balancing (#257) * DOCSP-47065: Load balancing * edit * word * RR feedback * DOCSP-47056: Monitoring (#260) * DOCSP-47056: Monitoring * fixes * fix * wording * table * widths * SA feedback * PV feedback * DOCSP-47071: Extended JSON (#268) * DOCSP-47071: Extended JSON * edits * vale * feedback * DOCSP-47072: Client parameters (#273) * DOCSP-47072: Client parameters * edits * fix * DOCSP-47069: Polling SRV records (#274) * DOCSP-50753: agg tutorial link (#275) * DOCSP-47063: Logging (#267) * DOCSP-47063: Logging * edits * word * feedback * code edit * fix * JT feedback * edit * spacing * gh link * JT feedback 2 * RR feedback * DOCSP-50185: Connection troubleshooting (#272) * DOCSP-50185: Connection troubleshooting * edits * remove sharedinclude * fix * wording * fix * MM feedback * DOCSP-50220: Break up FAQ (#276) * DOCSP-50220: Break up FAQ * edits * RM feedback * AB feedback * fix highlight * DOCSP-50960: Install with pie (#278) * DOCSP-50960: Install with pie * edits * RR feedback * JT feedback * DOCSP-51123: CC edits and cleanup (#279) * DOCSP-51123: CC edits and cleanup * build * composer * code errors * commas * more phpcs errors * edits * phpcs * code fixes * more phpcs * fix * RR feedback * DOCSP-50772: isView() (#281) * DOCSP-50772: isView() * fix manual link Co-authored-by: Nora Reidy <[email protected]> --------- Co-authored-by: Nora Reidy <[email protected]> * phpcs * vale * use toc labels/titles * more titles * label * Drop psalm analysis for doc examples * AB feedback * filter * title changes * build errors --------- Co-authored-by: Andreas Braun <[email protected]> Co-authored-by: Rea Rustagi <[email protected]> (cherry picked from commit 70a7512)
* Add redirects workflow * DOCSP-47058: Shift TOC (mongodb#251) * DOCSP-47058: Shift TOC * edits * issues and help, edits * fix errors * redirects * landing * RR feedback * RR feedback 2 * fix gh action * DOCSP-47057: Network compression (mongodb#254) * DOCSP-47057: Network compression * delete * edits * MM feedback * DOCSP-47055: Collation (mongodb#258) * DOCSP-47055: Collation * add to each page * edit * edits * list format * SA feedback * DOCSP-47060: Causal consistency (mongodb#261) * DOCSP-47060: Causal consistency * edits * Fix phpcs workflow * First fixes * Fix trailing commas * Fix string quoting * Fix whitespace errors * Fix use statements * Exclude sniff that would break comments * Fix multiline function declarations * Fix wrong array indentation * Fix snake_case variable names * Remove more false-positive errors * Fix control structure spacing * Fix arrays * Use property promotion * Simplify multiline array rules * Check code formatting (mongodb#265) * Check code formatting * fix highlighting * DOCSP-47059: Work with BSON (mongodb#263) * DOCSP-47059: Work with BSON * edits * RR feedback * enum ex * feedback * DOCSP-50222: Reorganize auth pages (mongodb#266) * DOCSP-50222: Reorganize auth pages * edits * fix * snooty * DOCSP-47065: Load balancing (mongodb#257) * DOCSP-47065: Load balancing * edit * word * RR feedback * DOCSP-47056: Monitoring (mongodb#260) * DOCSP-47056: Monitoring * fixes * fix * wording * table * widths * SA feedback * PV feedback * DOCSP-47071: Extended JSON (mongodb#268) * DOCSP-47071: Extended JSON * edits * vale * feedback * DOCSP-47072: Client parameters (mongodb#273) * DOCSP-47072: Client parameters * edits * fix * DOCSP-47069: Polling SRV records (mongodb#274) * DOCSP-50753: agg tutorial link (mongodb#275) * DOCSP-47063: Logging (mongodb#267) * DOCSP-47063: Logging * edits * word * feedback * code edit * fix * JT feedback * edit * spacing * gh link * JT feedback 2 * RR feedback * DOCSP-50185: Connection troubleshooting (mongodb#272) * DOCSP-50185: Connection troubleshooting * edits * remove sharedinclude * fix * wording * fix * MM feedback * DOCSP-50220: Break up FAQ (mongodb#276) * DOCSP-50220: Break up FAQ * edits * RM feedback * AB feedback * fix highlight * DOCSP-50960: Install with pie (mongodb#278) * DOCSP-50960: Install with pie * edits * RR feedback * JT feedback * DOCSP-51123: CC edits and cleanup (mongodb#279) * DOCSP-51123: CC edits and cleanup * build * composer * code errors * commas * more phpcs errors * edits * phpcs * code fixes * more phpcs * fix * RR feedback * DOCSP-50772: isView() (mongodb#281) * DOCSP-50772: isView() * fix manual link Co-authored-by: Nora Reidy <[email protected]> --------- Co-authored-by: Nora Reidy <[email protected]> * phpcs * vale * use toc labels/titles * more titles * label * Drop psalm analysis for doc examples * AB feedback * filter * title changes * build errors --------- Co-authored-by: Andreas Braun <[email protected]> Co-authored-by: Rea Rustagi <[email protected]> (cherry picked from commit 70a7512) (cherry picked from commit f11a732)
* PHP Comprehensive Coverage (#282) * Add redirects workflow * DOCSP-47058: Shift TOC (#251) * DOCSP-47058: Shift TOC * edits * issues and help, edits * fix errors * redirects * landing * RR feedback * RR feedback 2 * fix gh action * DOCSP-47057: Network compression (#254) * DOCSP-47057: Network compression * delete * edits * MM feedback * DOCSP-47055: Collation (#258) * DOCSP-47055: Collation * add to each page * edit * edits * list format * SA feedback * DOCSP-47060: Causal consistency (#261) * DOCSP-47060: Causal consistency * edits * Fix phpcs workflow * First fixes * Fix trailing commas * Fix string quoting * Fix whitespace errors * Fix use statements * Exclude sniff that would break comments * Fix multiline function declarations * Fix wrong array indentation * Fix snake_case variable names * Remove more false-positive errors * Fix control structure spacing * Fix arrays * Use property promotion * Simplify multiline array rules * Check code formatting (#265) * Check code formatting * fix highlighting * DOCSP-47059: Work with BSON (#263) * DOCSP-47059: Work with BSON * edits * RR feedback * enum ex * feedback * DOCSP-50222: Reorganize auth pages (#266) * DOCSP-50222: Reorganize auth pages * edits * fix * snooty * DOCSP-47065: Load balancing (#257) * DOCSP-47065: Load balancing * edit * word * RR feedback * DOCSP-47056: Monitoring (#260) * DOCSP-47056: Monitoring * fixes * fix * wording * table * widths * SA feedback * PV feedback * DOCSP-47071: Extended JSON (#268) * DOCSP-47071: Extended JSON * edits * vale * feedback * DOCSP-47072: Client parameters (#273) * DOCSP-47072: Client parameters * edits * fix * DOCSP-47069: Polling SRV records (#274) * DOCSP-50753: agg tutorial link (#275) * DOCSP-47063: Logging (#267) * DOCSP-47063: Logging * edits * word * feedback * code edit * fix * JT feedback * edit * spacing * gh link * JT feedback 2 * RR feedback * DOCSP-50185: Connection troubleshooting (#272) * DOCSP-50185: Connection troubleshooting * edits * remove sharedinclude * fix * wording * fix * MM feedback * DOCSP-50220: Break up FAQ (#276) * DOCSP-50220: Break up FAQ * edits * RM feedback * AB feedback * fix highlight * DOCSP-50960: Install with pie (#278) * DOCSP-50960: Install with pie * edits * RR feedback * JT feedback * DOCSP-51123: CC edits and cleanup (#279) * DOCSP-51123: CC edits and cleanup * build * composer * code errors * commas * more phpcs errors * edits * phpcs * code fixes * more phpcs * fix * RR feedback * DOCSP-50772: isView() (#281) * DOCSP-50772: isView() * fix manual link Co-authored-by: Nora Reidy <[email protected]> --------- Co-authored-by: Nora Reidy <[email protected]> * phpcs * vale * use toc labels/titles * more titles * label * Drop psalm analysis for doc examples * AB feedback * filter * title changes * build errors --------- Co-authored-by: Andreas Braun <[email protected]> Co-authored-by: Rea Rustagi <[email protected]> (cherry picked from commit 70a7512) (cherry picked from commit f11a732) * build errors * remove isView --------- Co-authored-by: Andreas Braun <[email protected]> Co-authored-by: Rea Rustagi <[email protected]>
Pull Request Info
PR Reviewing Guidelines
JIRA - https://jira.mongodb.org/browse/DOCSP-47058
Staging Links
Self-Review Checklist